<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>SQLScanner xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/torque/engine/sql/SQLScanner.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <strong>package</strong> <a href="../../../../../org/apache/torque/engine/sql/package-summary.html">org.apache.torque.engine.sql</a>;
<a name="2" href="#2">2</a>   
<a name="3" href="#3">3</a>   <em class="comment">/*</em>
<a name="4" href="#4">4</a>   <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="5" href="#5">5</a>   <em class="comment"> * or more contributor license agreements.  See the NOTICE file</em>
<a name="6" href="#6">6</a>   <em class="comment"> * distributed with this work for additional information</em>
<a name="7" href="#7">7</a>   <em class="comment"> * regarding copyright ownership.  The ASF licenses this file</em>
<a name="8" href="#8">8</a>   <em class="comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="9" href="#9">9</a>   <em class="comment"> * "License"); you may not use this file except in compliance</em>
<a name="10" href="#10">10</a>  <em class="comment"> * with the License.  You may obtain a copy of the License at</em>
<a name="11" href="#11">11</a>  <em class="comment"> *</em>
<a name="12" href="#12">12</a>  <em class="comment"> *   <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="13" href="#13">13</a>  <em class="comment"> *</em>
<a name="14" href="#14">14</a>  <em class="comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="15" href="#15">15</a>  <em class="comment"> * software distributed under the License is distributed on an</em>
<a name="16" href="#16">16</a>  <em class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="17" href="#17">17</a>  <em class="comment"> * KIND, either express or implied.  See the License for the</em>
<a name="18" href="#18">18</a>  <em class="comment"> * specific language governing permissions and limitations</em>
<a name="19" href="#19">19</a>  <em class="comment"> * under the License.</em>
<a name="20" href="#20">20</a>  <em class="comment"> */</em>
<a name="21" href="#21">21</a>  
<a name="22" href="#22">22</a>  <strong>import</strong> java.io.IOException;
<a name="23" href="#23">23</a>  <strong>import</strong> java.io.Reader;
<a name="24" href="#24">24</a>  <strong>import</strong> java.util.List;
<a name="25" href="#25">25</a>  <strong>import</strong> java.util.ArrayList;
<a name="26" href="#26">26</a>  
<a name="27" href="#27">27</a>  <em>/**<em>*</em></em>
<a name="28" href="#28">28</a>  <em> * A simple Scanner implementation that scans an</em>
<a name="29" href="#29">29</a>  <em> * sql file into usable tokens.  Used by SQLToAppData.</em>
<a name="30" href="#30">30</a>  <em> *</em>
<a name="31" href="#31">31</a>  <em> * @author &lt;a href="<a href="mailto:leon@opticode.co.za" target="alexandria_uri">mailto:leon@opticode.co.za</a>">Leon Messerschmidt&lt;/a></em>
<a name="32" href="#32">32</a>  <em> * @author &lt;a href="<a href="mailto:jon@latchkey.com" target="alexandria_uri">mailto:jon@latchkey.com</a>">Jon S. Stevens&lt;/a></em>
<a name="33" href="#33">33</a>  <em> * @author &lt;a href="<a href="mailto:andyhot@di.uoa.gr" target="alexandria_uri">mailto:andyhot@di.uoa.gr</a>">Andreas Andreou&lt;/a></em>
<a name="34" href="#34">34</a>  <em> * @version $Id: SQLScanner.java 473814 2006-11-11 22:30:30Z tv $</em>
<a name="35" href="#35">35</a>  <em> */</em>
<a name="36" href="#36">36</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../../org/apache/torque/engine/sql/SQLScanner.html">SQLScanner</a>
<a name="37" href="#37">37</a>  {
<a name="38" href="#38">38</a>      <em>/**<em>* white spaces */</em></em>
<a name="39" href="#39">39</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> String WHITE = <span class="string">"\f\r\t\n "</span>;
<a name="40" href="#40">40</a>      <em>/**<em>* alphabetic characters */</em></em>
<a name="41" href="#41">41</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> String ALFA
<a name="42" href="#42">42</a>              = <span class="string">"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"</span>;
<a name="43" href="#43">43</a>      <em>/**<em>* numbers */</em></em>
<a name="44" href="#44">44</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> String NUMER = <span class="string">"0123456789"</span>;
<a name="45" href="#45">45</a>      <em>/**<em>* alphanumeric */</em></em>
<a name="46" href="#46">46</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> String ALFANUM = ALFA + NUMER;
<a name="47" href="#47">47</a>      <em>/**<em>* special characters */</em></em>
<a name="48" href="#48">48</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> String SPECIAL = <span class="string">";(),'"</span>;
<a name="49" href="#49">49</a>      <em>/**<em>* comment */</em></em>
<a name="50" href="#50">50</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> <strong>char</strong> COMMENT_POUND = '#';
<a name="51" href="#51">51</a>      <em>/**<em>* comment */</em></em>
<a name="52" href="#52">52</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> <strong>char</strong> COMMENT_SLASH = '/';
<a name="53" href="#53">53</a>      <em>/**<em>* comment */</em></em>
<a name="54" href="#54">54</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> <strong>char</strong> COMMENT_STAR = '*';
<a name="55" href="#55">55</a>      <em>/**<em>* comment */</em></em>
<a name="56" href="#56">56</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> <strong>char</strong> COMMENT_DASH = '-';
<a name="57" href="#57">57</a>  
<a name="58" href="#58">58</a>      <em>/**<em>* the input reader */</em></em>
<a name="59" href="#59">59</a>      <strong>private</strong> Reader in;
<a name="60" href="#60">60</a>      <em>/**<em>* character */</em></em>
<a name="61" href="#61">61</a>      <strong>private</strong> <strong>int</strong> chr;
<a name="62" href="#62">62</a>      <em>/**<em>* token */</em></em>
<a name="63" href="#63">63</a>      <strong>private</strong> String token;
<a name="64" href="#64">64</a>      <em>/**<em>* list of tokens */</em></em>
<a name="65" href="#65">65</a>      <strong>private</strong> List tokens;
<a name="66" href="#66">66</a>      <em>/**<em>* line */</em></em>
<a name="67" href="#67">67</a>      <strong>private</strong> <strong>int</strong> line;
<a name="68" href="#68">68</a>      <em>/**<em>* column */</em></em>
<a name="69" href="#69">69</a>      <strong>private</strong> <strong>int</strong> col;
<a name="70" href="#70">70</a>  
<a name="71" href="#71">71</a>      <em>/**<em>*</em></em>
<a name="72" href="#72">72</a>  <em>     * Creates a new scanner with no Reader</em>
<a name="73" href="#73">73</a>  <em>     */</em>
<a name="74" href="#74">74</a>      <strong>public</strong> <a href="../../../../../org/apache/torque/engine/sql/SQLScanner.html">SQLScanner</a>()
<a name="75" href="#75">75</a>      {
<a name="76" href="#76">76</a>          <strong>this</strong>(<strong>null</strong>);
<a name="77" href="#77">77</a>      }
<a name="78" href="#78">78</a>  
<a name="79" href="#79">79</a>      <em>/**<em>*</em></em>
<a name="80" href="#80">80</a>  <em>     * Creates a new scanner with an Input Reader</em>
<a name="81" href="#81">81</a>  <em>     *</em>
<a name="82" href="#82">82</a>  <em>     * @param input the input reader</em>
<a name="83" href="#83">83</a>  <em>     */</em>
<a name="84" href="#84">84</a>      <strong>public</strong> <a href="../../../../../org/apache/torque/engine/sql/SQLScanner.html">SQLScanner</a>(Reader input)
<a name="85" href="#85">85</a>      {
<a name="86" href="#86">86</a>          setInput(input);
<a name="87" href="#87">87</a>      }
<a name="88" href="#88">88</a>  
<a name="89" href="#89">89</a>      <em>/**<em>*</em></em>
<a name="90" href="#90">90</a>  <em>     * Set the Input</em>
<a name="91" href="#91">91</a>  <em>     *</em>
<a name="92" href="#92">92</a>  <em>     * @param input the input reader</em>
<a name="93" href="#93">93</a>  <em>     */</em>
<a name="94" href="#94">94</a>      <strong>public</strong> <strong>void</strong> setInput(Reader input)
<a name="95" href="#95">95</a>      {
<a name="96" href="#96">96</a>          in = input;
<a name="97" href="#97">97</a>      }
<a name="98" href="#98">98</a>  
<a name="99" href="#99">99</a>  
<a name="100" href="#100">100</a>     <em>/**<em>*</em></em>
<a name="101" href="#101">101</a> <em>     * Reads the next character and increments the line and column counters.</em>
<a name="102" href="#102">102</a> <em>     *</em>
<a name="103" href="#103">103</a> <em>     * @throws IOException If an I/O error occurs</em>
<a name="104" href="#104">104</a> <em>     */</em>
<a name="105" href="#105">105</a>     <strong>private</strong> <strong>void</strong> readChar() throws IOException
<a name="106" href="#106">106</a>     {
<a name="107" href="#107">107</a>         <strong>boolean</strong> wasLine = (<strong>char</strong>) chr == '\r';
<a name="108" href="#108">108</a>         chr = in.read();
<a name="109" href="#109">109</a>         <strong>if</strong> ((<strong>char</strong>) chr == '\n' || (<strong>char</strong>) chr == '\r' || (<strong>char</strong>) chr == '\f')
<a name="110" href="#110">110</a>         {
<a name="111" href="#111">111</a>             col = 0;
<a name="112" href="#112">112</a>             <strong>if</strong> (!wasLine || (<strong>char</strong>) chr != '\n')
<a name="113" href="#113">113</a>             {
<a name="114" href="#114">114</a>                 line++;
<a name="115" href="#115">115</a>             }
<a name="116" href="#116">116</a>         }
<a name="117" href="#117">117</a>         <strong>else</strong>
<a name="118" href="#118">118</a>         {
<a name="119" href="#119">119</a>             col++;
<a name="120" href="#120">120</a>         }
<a name="121" href="#121">121</a>     }
<a name="122" href="#122">122</a> 
<a name="123" href="#123">123</a>     <em>/**<em>*</em></em>
<a name="124" href="#124">124</a> <em>     * Scans an identifier.</em>
<a name="125" href="#125">125</a> <em>     *</em>
<a name="126" href="#126">126</a> <em>     * @throws IOException If an I/O error occurs</em>
<a name="127" href="#127">127</a> <em>     */</em>
<a name="128" href="#128">128</a>     <strong>private</strong> <strong>void</strong> scanIdentifier () throws IOException
<a name="129" href="#129">129</a>     {
<a name="130" href="#130">130</a>         token = <span class="string">""</span>;
<a name="131" href="#131">131</a>         <strong>char</strong> c = (<strong>char</strong>) chr;
<a name="132" href="#132">132</a>         <strong>while</strong> (chr != -1 &amp;&amp; WHITE.indexOf(c) == -1 &amp;&amp; SPECIAL.indexOf(c) == -1)
<a name="133" href="#133">133</a>         {
<a name="134" href="#134">134</a>             token = token + (<strong>char</strong>) chr;
<a name="135" href="#135">135</a>             readChar();
<a name="136" href="#136">136</a>             c = (<strong>char</strong>) chr;
<a name="137" href="#137">137</a>         }
<a name="138" href="#138">138</a>         <strong>int</strong> start = col - token.length();
<a name="139" href="#139">139</a>         tokens.add(<strong>new</strong> <a href="../../../../../org/apache/torque/engine/sql/Token.html">Token</a>(token, line, start));
<a name="140" href="#140">140</a>     }
<a name="141" href="#141">141</a> 
<a name="142" href="#142">142</a>     <em>/**<em>*</em></em>
<a name="143" href="#143">143</a> <em>     * Scans an identifier which had started with the negative sign.</em>
<a name="144" href="#144">144</a> <em>     *</em>
<a name="145" href="#145">145</a> <em>     * @throws IOException If an I/O error occurs</em>
<a name="146" href="#146">146</a> <em>     */</em>
<a name="147" href="#147">147</a>     <strong>private</strong> <strong>void</strong> scanNegativeIdentifier () throws IOException
<a name="148" href="#148">148</a>     {
<a name="149" href="#149">149</a>         token = <span class="string">"-"</span>;
<a name="150" href="#150">150</a>         <strong>char</strong> c = (<strong>char</strong>) chr;
<a name="151" href="#151">151</a>         <strong>while</strong> (chr != -1 &amp;&amp; WHITE.indexOf(c) == -1 &amp;&amp; SPECIAL.indexOf(c) == -1)
<a name="152" href="#152">152</a>         {
<a name="153" href="#153">153</a>             token = token + (<strong>char</strong>) chr;
<a name="154" href="#154">154</a>             readChar();
<a name="155" href="#155">155</a>             c = (<strong>char</strong>) chr;
<a name="156" href="#156">156</a>         }
<a name="157" href="#157">157</a>         <strong>int</strong> start = col - token.length();
<a name="158" href="#158">158</a>         tokens.add(<strong>new</strong> <a href="../../../../../org/apache/torque/engine/sql/Token.html">Token</a>(token, line, start));
<a name="159" href="#159">159</a>     }
<a name="160" href="#160">160</a> 
<a name="161" href="#161">161</a>     <em>/**<em>*</em></em>
<a name="162" href="#162">162</a> <em>     * Scan the input Reader and returns a list of tokens.</em>
<a name="163" href="#163">163</a> <em>     *</em>
<a name="164" href="#164">164</a> <em>     * @return a list of tokens</em>
<a name="165" href="#165">165</a> <em>     * @throws IOException If an I/O error occurs</em>
<a name="166" href="#166">166</a> <em>     */</em>
<a name="167" href="#167">167</a>     <strong>public</strong> List scan () throws IOException
<a name="168" href="#168">168</a>     {
<a name="169" href="#169">169</a>         line = 1;
<a name="170" href="#170">170</a>         col = 0;
<a name="171" href="#171">171</a>         <strong>boolean</strong> inComment = false;
<a name="172" href="#172">172</a>         <strong>boolean</strong> inCommentSlashStar = false;
<a name="173" href="#173">173</a>         <strong>boolean</strong> inCommentDash = false;
<a name="174" href="#174">174</a> 
<a name="175" href="#175">175</a>         <strong>boolean</strong> inNegative;
<a name="176" href="#176">176</a> 
<a name="177" href="#177">177</a>         tokens = <strong>new</strong> ArrayList();
<a name="178" href="#178">178</a>         readChar();
<a name="179" href="#179">179</a>         <strong>while</strong> (chr != -1)
<a name="180" href="#180">180</a>         {
<a name="181" href="#181">181</a>             <strong>char</strong> c = (<strong>char</strong>) chr;
<a name="182" href="#182">182</a>             inNegative = false;
<a name="183" href="#183">183</a> 
<a name="184" href="#184">184</a>             <strong>if</strong> (c == COMMENT_DASH)
<a name="185" href="#185">185</a>             {
<a name="186" href="#186">186</a>                 readChar();
<a name="187" href="#187">187</a>                 <strong>if</strong> ((<strong>char</strong>) chr == COMMENT_DASH)
<a name="188" href="#188">188</a>                 {
<a name="189" href="#189">189</a>                     inCommentDash = <strong>true</strong>;
<a name="190" href="#190">190</a>                 }
<a name="191" href="#191">191</a>                 <strong>else</strong>
<a name="192" href="#192">192</a>                 {
<a name="193" href="#193">193</a>                     inNegative = <strong>true</strong>;
<a name="194" href="#194">194</a>                     c = (<strong>char</strong>) chr;
<a name="195" href="#195">195</a>                 }
<a name="196" href="#196">196</a>             }
<a name="197" href="#197">197</a> 
<a name="198" href="#198">198</a>             <strong>if</strong> (inCommentDash)
<a name="199" href="#199">199</a>             {
<a name="200" href="#200">200</a>                 <strong>if</strong> (c == '\n' || c == '\r')
<a name="201" href="#201">201</a>                 {
<a name="202" href="#202">202</a>                     inCommentDash = false;
<a name="203" href="#203">203</a>                 }
<a name="204" href="#204">204</a>                 readChar();
<a name="205" href="#205">205</a>             }
<a name="206" href="#206">206</a>             <strong>else</strong> <strong>if</strong> (c == COMMENT_POUND)
<a name="207" href="#207">207</a>             {
<a name="208" href="#208">208</a>                 inComment = <strong>true</strong>;
<a name="209" href="#209">209</a>                 readChar();
<a name="210" href="#210">210</a>             }
<a name="211" href="#211">211</a>             <strong>else</strong> <strong>if</strong> (c == COMMENT_SLASH)
<a name="212" href="#212">212</a>             {
<a name="213" href="#213">213</a>                 readChar();
<a name="214" href="#214">214</a>                 <strong>if</strong> ((<strong>char</strong>) chr == COMMENT_STAR)
<a name="215" href="#215">215</a>                 {
<a name="216" href="#216">216</a>                     inCommentSlashStar = <strong>true</strong>;
<a name="217" href="#217">217</a>                 }
<a name="218" href="#218">218</a>             }
<a name="219" href="#219">219</a>             <strong>else</strong> <strong>if</strong> (inComment || inCommentSlashStar)
<a name="220" href="#220">220</a>             {
<a name="221" href="#221">221</a>                 <strong>if</strong> (c == '*')
<a name="222" href="#222">222</a>                 {
<a name="223" href="#223">223</a>                     readChar();
<a name="224" href="#224">224</a>                     <strong>if</strong> ((<strong>char</strong>) chr == COMMENT_SLASH)
<a name="225" href="#225">225</a>                     {
<a name="226" href="#226">226</a>                         inCommentSlashStar = false;
<a name="227" href="#227">227</a>                     }
<a name="228" href="#228">228</a>                 }
<a name="229" href="#229">229</a>                 <strong>else</strong> <strong>if</strong> (c == '\n' || c == '\r')
<a name="230" href="#230">230</a>                 {
<a name="231" href="#231">231</a>                     inComment = false;
<a name="232" href="#232">232</a>                 }
<a name="233" href="#233">233</a>                 readChar();
<a name="234" href="#234">234</a>             }
<a name="235" href="#235">235</a>             <strong>else</strong> <strong>if</strong> (ALFANUM.indexOf(c) >= 0)
<a name="236" href="#236">236</a>             {
<a name="237" href="#237">237</a>                 <strong>if</strong> (inNegative)
<a name="238" href="#238">238</a>                 {
<a name="239" href="#239">239</a>                     scanNegativeIdentifier();
<a name="240" href="#240">240</a>                 }
<a name="241" href="#241">241</a>                 <strong>else</strong>
<a name="242" href="#242">242</a>                 {
<a name="243" href="#243">243</a>                     scanIdentifier();
<a name="244" href="#244">244</a>                 }
<a name="245" href="#245">245</a>             }
<a name="246" href="#246">246</a>             <strong>else</strong> <strong>if</strong> (SPECIAL.indexOf(c) >= 0)
<a name="247" href="#247">247</a>             {
<a name="248" href="#248">248</a>                 tokens.add(<strong>new</strong> <a href="../../../../../org/apache/torque/engine/sql/Token.html">Token</a>(<span class="string">""</span> + c, line, col));
<a name="249" href="#249">249</a>                 readChar();
<a name="250" href="#250">250</a>             }
<a name="251" href="#251">251</a>             <strong>else</strong>
<a name="252" href="#252">252</a>             {
<a name="253" href="#253">253</a>                 readChar();
<a name="254" href="#254">254</a>             }
<a name="255" href="#255">255</a>         }
<a name="256" href="#256">256</a>         <strong>return</strong> tokens;
<a name="257" href="#257">257</a>     }
<a name="258" href="#258">258</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

